FoxitPDFSDKPython2.AlternateTextFigureData Class Reference

Data structure for alternate text information of a figure.
More...

Inherits FoxitPDFSDKPython2._object.

Public Member Functions
def	AlternateTextFigureData ()
	Default constructor: creates an empty, non-decorative figure entry. More...
def	Set (is_decorative_figure, alternate_text, alternate_text_changed, page_index, rect)
	Set object values in one call. More...

Static Public Attributes
	alternate_text = _fsdk.AlternateTextFigureData_alternate_text
	The alternate text before change (original).
	alternate_text_changed = _fsdk.AlternateTextFigureData_alternate_text_changed
	The alternate text after change (modified in fix mode).
	is_decorative_figure = _fsdk.AlternateTextFigureData_is_decorative_figure
	Whether the figure is decorative (no alternate text).
	page_index = _fsdk.AlternateTextFigureData_page_index
	The page index where the figure is located. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .
	rect = _fsdk.AlternateTextFigureData_rect
	Bounding rectangle of the figure on the page.

Detailed Description

Data structure for alternate text information of a figure.

Stores information about a single figure used by accessibility tagging and fix workflows.

• is_decorative_figure: whether the figure is decorative and should not have alternate text.
  
• alternate_text: the original alternate text (before edit).
  
• alternate_text_changed: the alternate text after user modification (used in fix mode).
  
• page_index: the zero-based page index where the figure is located.
  
• rect: the bounding rectangle of the figure on the page.
  

Typical usage:

1. Iterate with TaggedPDF::GetNextFigureData() / GetPrevFigureData().
   
2. Modify using SetCurrentFigureDataInfo() and persist via TaggedPDF::SaveFigureData().
   

Constructor & Destructor Documentation

AlternateTextFigureData()

def FoxitPDFSDKPython2.AlternateTextFigureData.AlternateTextFigureData

(

)

Default constructor: creates an empty, non-decorative figure entry.

Copy constructor.

Construct with explicit values.

Parameters

[in]	is_decorative_figure	true if figure is decorative (no alt text).
[in]	alternate_text	original alternate text (may be null/empty).
[in]	alternate_text_changed	alternate text after change (may be null/empty).
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .
[in]	rect	bounding rectangle of the figure on the page.

Member Function Documentation

Set()

def FoxitPDFSDKPython2.AlternateTextFigureData.Set	(		is_decorative_figure,
			alternate_text,
			alternate_text_changed,
			page_index,
			rect
	)

Set object values in one call.

Parameters

[in]	is_decorative_figure	whether the figure is decorative.
[in]	alternate_text	original alternate text.
[in]	alternate_text_changed	alternate text after change.
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython2.PDFDoc.GetPageCount .
[in]	rect	bounding rectangle of the figure.